/*
 * Copyright (C) 2013 the original author or authors.
 * See the notice.md file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.code.vaadin.application.ui;

import com.google.code.vaadin.application.uiscope.UIKey;
import com.google.code.vaadin.application.uiscope.UIScope;
import com.vaadin.ui.UI;

/**
 * Base class for all Guice-Vaadin-MVP-based applications.
 *
 * @author Alexey Krylov
 * @see ScopedUIProvider
 * @since 23.01.13
 */
public abstract class ScopedUI extends UI {

    /*===========================================[ STATIC VARIABLES ]=============*/

    private static final long serialVersionUID = -9162640299567428524L;

    /*===========================================[ CLASS METHODS ]================*/

    private UIKey instanceKey;
    private UIScope uiScope;

    protected void setInstanceKey(UIKey instanceKey) {
        this.instanceKey = instanceKey;
    }

    public UIKey getInstanceKey() {
        return instanceKey;
    }

    protected void setScope(UIScope uiScope) {
        this.uiScope = uiScope;
    }

    @Override
    public void detach() {
        if (uiScope != null) {
            uiScope.releaseScope(instanceKey);
        }
        super.detach();
    }
}